home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / maximus / wasup101.zip / WHATSUP.DOC < prev    next >
Text File  |  1994-06-23  |  9KB  |  155 lines
  1.  
  2.  
  3.                         The What's Up status system
  4.  
  5.                       Another creation of Arthur Ward
  6.  
  7.                                 Version 1.01
  8.  
  9.  
  10. ================================================================================
  11. | Introduction                                                                 |
  12. ================================================================================
  13.     The What's Up status system is an attempt to create a fairly portable
  14. status program for sysops. Why? Because nobody else thought to make ONE
  15. program to handle the status of ALL of the BBS at once. That's why.
  16.     As currently designed, there are two basic modules; the status engine
  17. that is used in every copy of What's Up, and the interface. This allows
  18. modifications to the search engine without having to make tweaks in all of
  19. the interfaces. When finished, I hope to have good working DOS and Windows
  20. real-time interfaces. (and I'm already halfway there! :-)
  21.  
  22. ================================================================================
  23. | Setup - Care & Feeding                                                       |
  24. ================================================================================
  25. DOS notes:
  26.     The executable (whatsup.exe) and the configuration file (whatsup.cfg)
  27. must be in the same directory (but not necessarily the current directory).
  28. What's Up will always use the config file located in the directory the EXE
  29. is stored in, ignoring any config in the current directory. You cannot
  30. select an alternate configuration file.
  31.  
  32. Setting up the configuration file:
  33.     I think the sample configuration is commented & organized well enough
  34. that you should be able to just read through my comments. Each piece of
  35. software has it's own divider section, so you can look for those when
  36. flipping through.  Just remember that in order to enable a particular
  37. software AT ALL, you must have the entry for your software's name (or
  38. phrase resembling it :-) uncommented.
  39.  
  40. ================================================================================
  41. | DOS: Using What's Up                                                         |
  42. ================================================================================
  43.     A VERY simply interface is used:
  44. ┌───────────────────────────────────────────────────────────────────┐
  45. │ What's Up/DOS - Version 000.00 - Copyright 1994 Arthur Ward       │
  46. ├─Name─────────────────────Status───────────────────────────────────┤
  47. │ [name]                   [status]                                 │
  48. │ 1/3 screen here          2/3 screen here                          │
  49. └─Quit─commands...──────────────────────────────────────────...info─┘
  50.     At the top, the name of the program & copyright info, etc. The left
  51. column is the "name" for a status entry, the right column is the "status".
  52. At the bottom, is a subtle hint on how to get out (Quit; note capital Q :),
  53. and depending on the width of your screen, other things may show up.
  54. Generally speaking, commands are on the left, informative stuff is on the
  55. right.
  56.     On the bottom left, next to Quit will be listed all the available
  57. status searches that you have configured. When first starting, all statuses
  58. default to on (yellow), but each search can be toggled at will, generally
  59. with the first capitalized (see below). If you butchered the example
  60. configuration file, this is a simple way to tell if you at least have all
  61. the right verbs in the configuration for your software.
  62.     Throw your wildest somewhat-standard text mode screen at What's Up, and
  63. it should adjust name/status to keep their approx. divisions along the
  64. first third of the screen. Likewise, if it can't fit things on the bottom
  65. line, it will drop items from there (ends are drawn first; names of search
  66. routines (ie. BinkleyTerm, Maximus) will be abbreviated up to 1 letter
  67. before being dropped).
  68.  
  69. Active keys in the real-time DOS interface:
  70.     Q       Quit
  71.     B       Toggle BinkleyTerm on/off   }   The corresponding label will
  72.     M       Toggle Maximus on/off       }   switch between yellow/brown to
  73.                                             indicate active/inactive
  74.  
  75. Note on use in Windows:
  76.     I find that setting a PIF for What's Up to use priorities of 100/100
  77. (or your own normal foreground setting) for both entries provides best
  78. performance as a whole. What's Up releases all the time it can, so the high
  79. priority allows the brief scan for flags to remain brief instead of
  80. dragging out like at 100/50.
  81.     When being used in a window, VGA Effects (ie. the passive screen saver)
  82. do not show up because Windows is trying to keep the palette under control
  83. for the rest of the screen. Switch it to full-screen and Windows restores
  84. control over the palette back to me and the saver works.
  85.  
  86. ================================================================================
  87. | Just little scraps of information about the features...                      |
  88. ================================================================================
  89. BinkleyTerm status: Supports 4D outbound structure using .BSY flags,
  90. TASK.xx, BTRESCAN.xx, and BTEXITxx.yy.
  91.  
  92. Maximus 2.x: All I'm doing is reading the name & status from the IPC files
  93. in the IPC directory (and appending the task number to the name). This
  94. should be the same as the Who's Online command or chat menu header in
  95. Maximus.
  96.  
  97. Passive Screen Saver: I call it "passive" in that the screen is not blanked
  98. or otherwise changed, but you can still read it while it is saving. Colors
  99. are restored normally on a non-error exit, but if there's a sharing
  100. violation or other type of screwup that causes it to barf and not shutdown
  101. correctly, your palette will be hosed. Speed of change depends on your
  102. delay setting and your system's particular text mode palette. If you want
  103. to see the fade at maximum speed, set delay to 0, comment out your status
  104. verbs (BinkleyTerm, etc.), then run.
  105.  
  106. ================================================================================
  107. | But, but, how could you possibly leave out SuperWidget?                      |
  108. ================================================================================
  109.     I know this by no means covers all the software out there, so I need
  110. your help to gather up information on the status flags for other software
  111. that I don't use. If you want your software to be included, send me
  112. everything you can find on how to obtain the status through flag files and
  113. status files. Also, the programmers out there might want to look at
  114. newmods.txt.
  115.  
  116. ================================================================================
  117. | Waiter, there's a bug in my status!                                          |
  118. ================================================================================
  119.     Bugs? Let me know!
  120.     Try to determine what flag (or flags) caused the problem, and/or total
  121. number of flags that were currently being checked, and any other
  122. information you think (or don't think) to be relevant. Send it all to me
  123. through one of the channels listed at the end of this document.
  124.  
  125. ================================================================================
  126. | Credits                                                                      |
  127. ================================================================================
  128. Max Campos          . Came up with the RemoteAccess 2.00 structures in C (!)
  129.  Sherwood Forest    . Bugged me to death with bugs. :-)  (good job!)
  130.  1:106/6073
  131.  
  132. ================================================================================
  133. | What's Up with Money                                                         |
  134. ================================================================================
  135.     I ask for no payment for this version of What's Up, but I do reserve
  136. the right to change this in future versions.
  137.     However, I do ask, that if you find that What's Up is useful, and feel
  138. that it would be worth paying a few dollars for, go ahead and donate that
  139. small amount to me. US currency only, no foreign money, please, as that
  140. will only go into a coin collection.
  141.  
  142. ================================================================================
  143. | Contact                                                                      |
  144. ================================================================================
  145. U.S.nail Mail:             |  via. the _REAL_ information superhighways:
  146. Arthur Ward                | 1. FidoNet: 1:106/321
  147. 11212 Sagecountry          | 2. InterNet: f321.n106.z1@fidonet.org
  148. Houston, Texas 77089       | 3. BBS: Squeak!: 1-713-485-0321, 2400bps
  149. (United States of America) |    Online 24 hours/day except 3-4am CST.
  150.  ^ last resort please ^    |
  151.  
  152. BBS note: I use a callback system, and cannot do long-distance validations.
  153. One-way messaging can be achieved by logging in (*quickly*!), logging off
  154. and leaving a comment for me during the logout. Replies won't be possible. :(
  155.